Rebrand README for ProxySQL LLC maintainership#14
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request rebrands the Orchestrator project's README to reflect its new maintainership under ProxySQL LLC. The changes aim to clearly communicate the project's current status, future direction, and community engagement opportunities, while updating all external links and historical context to align with the transition. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
📝 WalkthroughWalkthroughThe README.md file was updated to reflect ProxySQL ownership, including changes to badge URLs, documentation links, logo image paths, and the maintainer statement. Additional sections for Future Vision, Lineage, and Community were added, while obsolete references to OpenArk and Google Groups were removed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to reflect the new maintainership by ProxySQL LLC. The changes include updating URLs, logos, and maintainer information, as well as adding new sections for 'Future Vision' and 'Community'. The project lineage has also been clarified. My review found a small typo in the year of maintainership, which I've commented on. Overall, the changes are clear and achieve the goal of rebranding the project's README.
|
|
||
| Maintained by [Percona](https://percona.com) as https://github.com/percona/orchestrator | ||
|
|
||
| Maintained since 2026 by [ProxySQL LLC](https://proxysql.com) as https://github.com/proxysql/orchestrator |
There was a problem hiding this comment.
The year 2026 is in the future and appears to be a typo. To avoid confusion, I suggest removing the year for now, making it consistent with the format of the 'Maintained by Percona' line. The correct year can be added later.
| Maintained since 2026 by [ProxySQL LLC](https://proxysql.com) as https://github.com/proxysql/orchestrator | |
| Maintained by [ProxySQL LLC](https://proxysql.com) as https://github.com/proxysql/orchestrator |
There was a problem hiding this comment.
Pull request overview
Updates the project README to reflect ProxySQL LLC as the current maintainer and to re-point repository/documentation references to proxysql/orchestrator.
Changes:
- Replaces the prior Percona fork notice with a ProxySQL LLC maintainer statement and contribution invitation.
- Updates badges and documentation links to the
proxysql/orchestratorGitHub org/repo and switches the logo to a local image path. - Adds new “Future Vision”, expanded lineage, and a “Community” section with governance links.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **ProxySQL-native integration** — built-in hooks and topology awareness for seamless orchestrator + ProxySQL HA workflows, no custom scripts needed. | ||
| - **PostgreSQL exploration** — a database-provider abstraction layer to support PostgreSQL streaming replication alongside MySQL. | ||
|
|
||
| Read the [Orchestrator documentation](https://github.com/proxysql/orchestrator/tree/master/docs) |
There was a problem hiding this comment.
This second documentation link also hard-codes tree/master/docs. For consistency and to prevent branch-name related breakage, switch this to the same relative docs link used elsewhere in the README (e.g., docs/).
| Read the [Orchestrator documentation](https://github.com/proxysql/orchestrator/tree/master/docs) | |
| Read the [Orchestrator documentation](docs/) |
| - [Contributing Guide](CONTRIBUTING.md) — how to file issues, submit PRs, and coding standards | ||
| - [Code of Conduct](CODE_OF_CONDUCT.md) — expected behavior in the community | ||
| - [Security Policy](SECURITY.md) — how to report vulnerabilities | ||
| - [Maintainers](MAINTAINERS.md) — current project maintainers |
There was a problem hiding this comment.
The new Community links point to CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, and MAINTAINERS.md, but those files are not present in this repo. This makes the README links 404. Either add these governance files in this PR, or update the links to existing equivalents (e.g., docs/contributions.md, docs/security.md) and omit links that don’t exist yet.
| - [Maintainers](MAINTAINERS.md) — current project maintainers | |
| - Maintainers — current project maintainers |
| > **Maintained by [ProxySQL LLC](https://proxysql.com).** Orchestrator is actively maintained and open to contributions. We believe in orchestrator's potential as the go-to MySQL HA tool, especially when paired with ProxySQL. Bug reports, feature requests, and pull requests are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) to get started. | ||
|
|
||
| >We are not currently entertaining external enhancements or feature requests. We do, however, believe Orchestrator has potential and are open to exploring its future as a community-driven project. We welcome collaboration with interested organizations. Our priority is determining whether sufficient resources (time and funding) can be secured to ensure Orchestrator's continued maintenance and development. We're open to discussing potential partnerships with organizations who might be interested in supporting this effort. | ||
| # orchestrator [[Documentation]](https://github.com/proxysql/orchestrator/tree/master/docs) |
There was a problem hiding this comment.
The documentation link hard-codes tree/master/docs, but this repository’s base branch appears to be main (and the README later uses a relative /docs/... link). To avoid broken links if the default branch name changes, prefer a relative link like docs/ (or /docs/README.md) instead of https://github.com/.../tree/master/docs.
| # orchestrator [[Documentation]](https://github.com/proxysql/orchestrator/tree/master/docs) | |
| # orchestrator [[Documentation]](docs/) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
README.md (1)
72-78: Consider clarifying the lineage date ranges for maintainer transitions.The lineage section accurately documents the project's history, but the date range "2020-" on Line 74 might be slightly ambiguous now that active maintenance has transitioned to ProxySQL LLC. Consider whether "2020-2026" would more clearly indicate the active maintenance period under openark, even though the repository still exists.
This is a minor readability suggestion — the current format is technically correct if openark/orchestrator remains available as a historical reference.
Optional: Clarify date range for openark maintenance
-- 2020- as https://github.com/openark/orchestrator +- 2020-2026 as https://github.com/openark/orchestrator🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 72 - 78, Update the lineage date ranges in the README so the openark entry "2020- as https://github.com/openark/orchestrator" explicitly shows its end year (e.g., "2020-2026") to reflect the maintenance transition, and ensure the ProxySQL entry "Maintained since 2026 by [ProxySQL LLC] as https://github.com/proxysql/orchestrator" remains unchanged; locate and edit the exact lines containing the strings "2020- as https://github.com/openark/orchestrator" and "Maintained since 2026 by [ProxySQL LLC] as https://github.com/proxysql/orchestrator" to replace "2020-" with "2020-2026" (or another chosen end year) for clearer historical clarity.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 1-3: The markdown badges at the top use image syntax without alt
text; update each badge image token (for example the three lines containing the
URLs https://github.com/proxysql/orchestrator/workflows/CI/badge.svg,
.../upgrade/badge.svg, and .../system%20tests/badge.svg) to include descriptive
alt text (e.g., "CI build status", "upgrade workflow status", "system tests
status") by adding an alt string inside the square brackets for each image.
- Line 6: The README currently links to governance files (CONTRIBUTING.md,
CODE_OF_CONDUCT.md, SECURITY.md, MAINTAINERS.md) that do not exist yet; update
the README (edit the paragraph around the "Maintained by" / Community section
where CONTRIBUTING.md is referenced) to add a short note stating that these
governance files will be added as part of Task 3 and that links will be
available after Task 3 merges, or alternatively wait to merge this PR until Task
3 is merged so the links are valid—make the change to the README.md text near
the existing CONTRIBUTING.md reference to clearly set expectations for users.
---
Nitpick comments:
In `@README.md`:
- Around line 72-78: Update the lineage date ranges in the README so the openark
entry "2020- as https://github.com/openark/orchestrator" explicitly shows its
end year (e.g., "2020-2026") to reflect the maintenance transition, and ensure
the ProxySQL entry "Maintained since 2026 by [ProxySQL LLC] as
https://github.com/proxysql/orchestrator" remains unchanged; locate and edit the
exact lines containing the strings "2020- as
https://github.com/openark/orchestrator" and "Maintained since 2026 by [ProxySQL
LLC] as https://github.com/proxysql/orchestrator" to replace "2020-" with
"2020-2026" (or another chosen end year) for clearer historical clarity.
|  | ||
|  | ||
|  |
There was a problem hiding this comment.
Add alt text to badge images for accessibility.
The CI/workflow badge images lack alt text, which prevents screen reader users from understanding the build status. Line 4 demonstrates the correct pattern with descriptive alt text.
♿ Proposed fix to add descriptive alt text
-
-
-
+
+
+🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 1-1: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 2-2: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 3-3: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 1 - 3, The markdown badges at the top use image
syntax without alt text; update each badge image token (for example the three
lines containing the URLs
https://github.com/proxysql/orchestrator/workflows/CI/badge.svg,
.../upgrade/badge.svg, and .../system%20tests/badge.svg) to include descriptive
alt text (e.g., "CI build status", "upgrade workflow status", "system tests
status") by adding an alt string inside the square brackets for each image.
| [](https://github.com/proxysql/orchestrator/releases) [](https://github.com/proxysql/orchestrator/releases) | ||
|
|
||
| > **NOTE:** This is a fork of the abandoned [Orchestrator](https://github.com/openark/orchestrator) project. Percona is not the public maintainer of the Orchestrator project. We modify this fork almost exclusively for use in our Kubernetes Operators, but we make our changes available to the open-source community if they suit your needs. | ||
| > **Maintained by [ProxySQL LLC](https://proxysql.com).** Orchestrator is actively maintained and open to contributions. We believe in orchestrator's potential as the go-to MySQL HA tool, especially when paired with ProxySQL. Bug reports, feature requests, and pull requests are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) to get started. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify governance files referenced in README exist
echo "Checking for governance files..."
for file in CONTRIBUTING.md CODE_OF_CONDUCT.md SECURITY.md MAINTAINERS.md; do
if [ -f "$file" ]; then
echo "✓ $file exists"
else
echo "✗ $file NOT found"
fi
done
echo -e "\nIf files are missing, consider:"
echo "1. Merging Task 3 first (as noted in PR test plan)"
echo "2. Or add a comment in the Community section: '(governance files coming in #<task3-pr-number>)'"Repository: ProxySQL/orchestrator
Length of output: 387
Governance files are missing, creating broken links in the README.
The governance files referenced in line 6 (CONTRIBUTING.md) and the Community section (CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, MAINTAINERS.md) do not exist in the current branch, so the links will be broken when this PR merges.
Since the PR test plan indicates these files "will work once Task 3 merges," either:
- Ensure Task 3 is merged before this PR, or
- Add a note in the README indicating these governance files are coming in Task 3 to set expectations for users who encounter the broken links.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 6, The README currently links to governance files
(CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, MAINTAINERS.md) that do not
exist yet; update the README (edit the paragraph around the "Maintained by" /
Community section where CONTRIBUTING.md is referenced) to add a short note
stating that these governance files will be added as part of Task 3 and that
links will be available after Task 3 merges, or alternatively wait to merge this
PR until Task 3 is merged so the links are valid—make the change to the
README.md text near the existing CONTRIBUTING.md reference to clearly set
expectations for users.
Summary
openark/orchestratortoproxysql/orchestratororchestrator@percona.comcontact and Percona-specific languageTest plan
proxysql/orchestratorproxysql/orchestratorSummary by CodeRabbit